A filtered list of recorded time series is returned. Call parameters allow filtering according to a specific time period. If the device is the programmable logic controller of a machine or a virtual device that combines several programmable logic controllers of a machine, the time series represent the recorded process parameters. In this case, it is also possible to filter according to a specific operation that was executed on the machine.
curl -X GET "https://localhost:24080/ffwebservices/api/v2/devices/{deviceId}/recordedTimeSeries?endDate=&limit=&materialNumber=&operationNumber=&paginationDirection=&paginationTimestamp=&productionOrderNumber=&startDate=&tag=&workplaceId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceApi;
import java.io.File;
import java.util.*;
public class DeviceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: oauth2schema
OAuth oauth2schema = (OAuth) defaultClient.getAuthentication("oauth2schema");
oauth2schema.setAccessToken("YOUR ACCESS TOKEN");
DeviceApi apiInstance = new DeviceApi();
String deviceId = deviceId_example; // String | UUID of a device
Date endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period. Default value: current time
Integer limit = 56; // Integer | Size of the requested page
String materialNumber = materialNumber_example; // String | Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period
String operationNumber = operationNumber_example; // String | Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period
String paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages
Date paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination
String productionOrderNumber = productionOrderNumber_example; // String | Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period
Date startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
Long tag = 789; // Long | Tag for a specific variable or process parameter
String workplaceId = workplaceId_example; // String | UUID of the workplace.
try {
deviceRecordedTimeSeriesCollection result = apiInstance.getRecordedTimeSeries(deviceId, endDate, limit, materialNumber, operationNumber, paginationDirection, paginationTimestamp, productionOrderNumber, startDate, tag, workplaceId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceApi#getRecordedTimeSeries");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DeviceApi;
public class DeviceApiExample {
public static void main(String[] args) {
DeviceApi apiInstance = new DeviceApi();
String deviceId = deviceId_example; // String | UUID of a device
Date endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period. Default value: current time
Integer limit = 56; // Integer | Size of the requested page
String materialNumber = materialNumber_example; // String | Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period
String operationNumber = operationNumber_example; // String | Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period
String paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages
Date paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination
String productionOrderNumber = productionOrderNumber_example; // String | Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period
Date startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
Long tag = 789; // Long | Tag for a specific variable or process parameter
String workplaceId = workplaceId_example; // String | UUID of the workplace.
try {
deviceRecordedTimeSeriesCollection result = apiInstance.getRecordedTimeSeries(deviceId, endDate, limit, materialNumber, operationNumber, paginationDirection, paginationTimestamp, productionOrderNumber, startDate, tag, workplaceId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DeviceApi#getRecordedTimeSeries");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2schema)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *deviceId = deviceId_example; // UUID of a device
Date *endDate = 2013-10-20T19:20:30+01:00; // The end date of the considered period. Default value: current time (optional)
Integer *limit = 56; // Size of the requested page (optional) (default to 100)
String *materialNumber = materialNumber_example; // Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period (optional)
String *operationNumber = operationNumber_example; // Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period (optional)
String *paginationDirection = paginationDirection_example; // Direction on how to navigate through the response pages (optional) (default to NEXT)
Date *paginationTimestamp = 2013-10-20T19:20:30+01:00; // Timestamp used for pagination (optional)
String *productionOrderNumber = productionOrderNumber_example; // Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period (optional)
Date *startDate = 2013-10-20T19:20:30+01:00; // The start date of the considered period (optional) (default to Beginning of the current week)
Long *tag = 789; // Tag for a specific variable or process parameter (optional)
String *workplaceId = workplaceId_example; // UUID of the workplace. (optional)
DeviceApi *apiInstance = [[DeviceApi alloc] init];
// Retrieve the recorded time series of a device.
[apiInstance getRecordedTimeSeriesWith:deviceId
endDate:endDate
limit:limit
materialNumber:materialNumber
operationNumber:operationNumber
paginationDirection:paginationDirection
paginationTimestamp:paginationTimestamp
productionOrderNumber:productionOrderNumber
startDate:startDate
tag:tag
workplaceId:workplaceId
completionHandler: ^(deviceRecordedTimeSeriesCollection output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var BridgeMdcApi = require('bridge_mdc_api');
var defaultClient = BridgeMdcApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"
var api = new BridgeMdcApi.DeviceApi()
var deviceId = deviceId_example; // {String} UUID of a device
var opts = {
'endDate': 2013-10-20T19:20:30+01:00, // {Date} The end date of the considered period. Default value: current time
'limit': 56, // {Integer} Size of the requested page
'materialNumber': materialNumber_example, // {String} Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period
'operationNumber': operationNumber_example, // {String} Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period
'paginationDirection': paginationDirection_example, // {String} Direction on how to navigate through the response pages
'paginationTimestamp': 2013-10-20T19:20:30+01:00, // {Date} Timestamp used for pagination
'productionOrderNumber': productionOrderNumber_example, // {String} Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period
'startDate': 2013-10-20T19:20:30+01:00, // {Date} The start date of the considered period
'tag': 789, // {Long} Tag for a specific variable or process parameter
'workplaceId': workplaceId_example // {String} UUID of the workplace.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getRecordedTimeSeries(deviceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getRecordedTimeSeriesExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2schema
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new DeviceApi();
var deviceId = deviceId_example; // String | UUID of a device
var endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period. Default value: current time (optional)
var limit = 56; // Integer | Size of the requested page (optional) (default to 100)
var materialNumber = materialNumber_example; // String | Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period (optional)
var operationNumber = operationNumber_example; // String | Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period (optional)
var paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages (optional) (default to NEXT)
var paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination (optional)
var productionOrderNumber = productionOrderNumber_example; // String | Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period (optional)
var startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period (optional) (default to Beginning of the current week)
var tag = 789; // Long | Tag for a specific variable or process parameter (optional)
var workplaceId = workplaceId_example; // String | UUID of the workplace. (optional)
try
{
// Retrieve the recorded time series of a device.
deviceRecordedTimeSeriesCollection result = apiInstance.getRecordedTimeSeries(deviceId, endDate, limit, materialNumber, operationNumber, paginationDirection, paginationTimestamp, productionOrderNumber, startDate, tag, workplaceId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DeviceApi.getRecordedTimeSeries: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2schema
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\Api\DeviceApi();
$deviceId = deviceId_example; // String | UUID of a device
$endDate = 2013-10-20T19:20:30+01:00; // Date | The end date of the considered period. Default value: current time
$limit = 56; // Integer | Size of the requested page
$materialNumber = materialNumber_example; // String | Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period
$operationNumber = operationNumber_example; // String | Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period
$paginationDirection = paginationDirection_example; // String | Direction on how to navigate through the response pages
$paginationTimestamp = 2013-10-20T19:20:30+01:00; // Date | Timestamp used for pagination
$productionOrderNumber = productionOrderNumber_example; // String | Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period
$startDate = 2013-10-20T19:20:30+01:00; // Date | The start date of the considered period
$tag = 789; // Long | Tag for a specific variable or process parameter
$workplaceId = workplaceId_example; // String | UUID of the workplace.
try {
$result = $api_instance->getRecordedTimeSeries($deviceId, $endDate, $limit, $materialNumber, $operationNumber, $paginationDirection, $paginationTimestamp, $productionOrderNumber, $startDate, $tag, $workplaceId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DeviceApi->getRecordedTimeSeries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeviceApi;
# Configure OAuth2 access token for authorization: oauth2schema
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::DeviceApi->new();
my $deviceId = deviceId_example; # String | UUID of a device
my $endDate = 2013-10-20T19:20:30+01:00; # Date | The end date of the considered period. Default value: current time
my $limit = 56; # Integer | Size of the requested page
my $materialNumber = materialNumber_example; # String | Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period
my $operationNumber = operationNumber_example; # String | Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period
my $paginationDirection = paginationDirection_example; # String | Direction on how to navigate through the response pages
my $paginationTimestamp = 2013-10-20T19:20:30+01:00; # Date | Timestamp used for pagination
my $productionOrderNumber = productionOrderNumber_example; # String | Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period
my $startDate = 2013-10-20T19:20:30+01:00; # Date | The start date of the considered period
my $tag = 789; # Long | Tag for a specific variable or process parameter
my $workplaceId = workplaceId_example; # String | UUID of the workplace.
eval {
my $result = $api_instance->getRecordedTimeSeries(deviceId => $deviceId, endDate => $endDate, limit => $limit, materialNumber => $materialNumber, operationNumber => $operationNumber, paginationDirection => $paginationDirection, paginationTimestamp => $paginationTimestamp, productionOrderNumber => $productionOrderNumber, startDate => $startDate, tag => $tag, workplaceId => $workplaceId);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DeviceApi->getRecordedTimeSeries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: oauth2schema
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.DeviceApi()
deviceId = deviceId_example # String | UUID of a device
endDate = 2013-10-20T19:20:30+01:00 # Date | The end date of the considered period. Default value: current time (optional)
limit = 56 # Integer | Size of the requested page (optional) (default to 100)
materialNumber = materialNumber_example # String | Material number of a material produced.
To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period (optional)
operationNumber = operationNumber_example # String | Operation number of an executed operation.
To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period (optional)
paginationDirection = paginationDirection_example # String | Direction on how to navigate through the response pages (optional) (default to NEXT)
paginationTimestamp = 2013-10-20T19:20:30+01:00 # Date | Timestamp used for pagination (optional)
productionOrderNumber = productionOrderNumber_example # String | Production Order number of an executed production order.
To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period (optional)
startDate = 2013-10-20T19:20:30+01:00 # Date | The start date of the considered period (optional) (default to Beginning of the current week)
tag = 789 # Long | Tag for a specific variable or process parameter (optional)
workplaceId = workplaceId_example # String | UUID of the workplace. (optional)
try:
# Retrieve the recorded time series of a device.
api_response = api_instance.get_recorded_time_series(deviceId, endDate=endDate, limit=limit, materialNumber=materialNumber, operationNumber=operationNumber, paginationDirection=paginationDirection, paginationTimestamp=paginationTimestamp, productionOrderNumber=productionOrderNumber, startDate=startDate, tag=tag, workplaceId=workplaceId)
pprint(api_response)
except ApiException as e:
print("Exception when calling DeviceApi->getRecordedTimeSeries: %s\n" % e)